Improved selection placement when emoji is typed #22827

alitoshmatov · 2023-07-13T17:34:34Z

Details

Introduced getCommonSuffixLength and improved current logic of placing cursor after emoji is typed

Fixed Issues

$ #17275
PROPOSAL: #17275 (comment)

Tests

Go to any chat
Type emoji name like, but make sure cursor is in the middle of text when completed
You can do :smmile: and move your cursor after second m and remove it to place your cursor in the middle of text when emoji name is completed
Make sure when emoji name is replaced with emoji itself cursor is placed right after emoji

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web-emoji.mov

Mobile Web - Chrome

mWeb-emoji.mp4

Mobile Web - Safari

safari-emoji.mp4

Desktop

desktop-emoji.mov

iOS

ios-emoji.mp4

Android

android-emoji.mp4

melvin-bot · 2023-07-13T17:34:40Z

@aimane-chnaif Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

alitoshmatov · 2023-07-13T17:36:55Z

Looks like there is a problem with selection in native devices, controlled selection is not working in android and ios apps, that's why we cannot control cursor correctly.

I found this issue which talks about selection not working in android - #12854

aimane-chnaif · 2023-07-14T04:53:14Z

Android controlled selection is very buggy at the moment. I can confirm that this also happens on main

android.mov

aimane-chnaif · 2023-07-14T04:56:20Z

@alitoshmatov have you found any known E/App GH that iOS controlled selection is not working?

alitoshmatov · 2023-07-14T09:04:58Z

@aimane-chnaif No I couldn't find similar issue for ios

aimane-chnaif · 2023-07-14T09:28:36Z

I also tested all other solutions on iOS and none of them working.
Given that iOS/Android selection issues are more complex and have different root causes (not only emoji) and our change doesn't affect production app, I think they can be out of scope for this PR. More likely to be fixed in upstream.
cc: @MariaHCD

aimane-chnaif · 2023-07-14T09:48:48Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

hello-smhilea-.mov

test-smhahaile-.mov

paste.mov

mention.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

aimane-chnaif

@MariaHCD all yours!

MariaHCD

Let's make the function docs and name a bit more clear. I've posted my suggestions but open to your opinions as well!

src/libs/ComposerUtils/index.js

aimane-chnaif

MariaHCD

Nice!

OSBotify · 2023-07-17T08:07:51Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-07-17T19:38:23Z

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.3.42-0 🚀

platform	result
🤖 android 🤖	cancelled 🔪
🖥 desktop 🖥	cancelled 🔪
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	cancelled 🔪

OSBotify · 2023-07-19T18:00:09Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

eVoloshchak · 2023-10-11T14:25:42Z

src/pages/home/report/ReportActionCompose.js

            const newState = {
                isCommentEmpty: !!newComment.match(/^(\s)*$/),
                value: newComment,
            };
            if (comment !== newComment) {
-                const remainder = prevState.value.slice(prevState.selection.end).length;
+                const remainder = ComposerUtils.getCommonSuffixLength(comment, newComment);


Coming from #27195, this has caused a small inconsistency between the composer when sending a message and when editing it.
We should have used the same calculation for the remainder (getCommonSuffixLength) in ReportActionItemMessageEdit too.

Added getCommonEndingLength and implemented it

31096c5

alitoshmatov requested a review from a team as a code owner July 13, 2023 17:34

melvin-bot bot requested review from aimane-chnaif and removed request for a team July 13, 2023 17:34

alitoshmatov mentioned this pull request Jul 13, 2023

[HOLD for payment 2023-07-26] [$1000] Cursor jumps to previous word while correcting incorrect emoji #17275

Closed

6 tasks

aimane-chnaif approved these changes Jul 14, 2023

View reviewed changes

melvin-bot bot requested a review from MariaHCD July 14, 2023 09:54

MariaHCD requested changes Jul 14, 2023

View reviewed changes

src/libs/ComposerUtils/index.js Outdated Show resolved Hide resolved

src/libs/ComposerUtils/index.js Outdated Show resolved Hide resolved

Updated function name

e1580b5

aimane-chnaif reviewed Jul 17, 2023

View reviewed changes

MariaHCD approved these changes Jul 17, 2023

View reviewed changes

MariaHCD merged commit d71a2be into Expensify:main Jul 17, 2023

0xmiros mentioned this pull request Jul 17, 2023

Migrate ReportActionCompose to function #18648

Merged

56 tasks

OSBotify mentioned this pull request Jul 17, 2023

Deploy Checklist: New Expensify 2023-07-17 #23033

Closed

Ollyws mentioned this pull request Sep 26, 2023

[HOLD for payment 2023-10-09] [$500] Web - Pasting emojis freezes cursor position in composer box (works fine in edit message) #27672

Closed

6 tasks

eVoloshchak reviewed Oct 11, 2023

View reviewed changes

eVoloshchak mentioned this pull request Oct 11, 2023

[HOLD for payment 2023-10-10] [$500] Web - Inconsistency bug: App adds space after emoji in composer box but does not add space after emoji in edit #27195

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved selection placement when emoji is typed #22827

Improved selection placement when emoji is typed #22827

alitoshmatov commented Jul 13, 2023 •

edited by MariaHCD

Loading

melvin-bot bot commented Jul 13, 2023

alitoshmatov commented Jul 13, 2023 •

edited

Loading

aimane-chnaif commented Jul 14, 2023 •

edited

Loading

aimane-chnaif commented Jul 14, 2023

alitoshmatov commented Jul 14, 2023

aimane-chnaif commented Jul 14, 2023

aimane-chnaif commented Jul 14, 2023

aimane-chnaif left a comment

MariaHCD left a comment

aimane-chnaif left a comment

MariaHCD left a comment

OSBotify commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 19, 2023

eVoloshchak Oct 11, 2023

Improved selection placement when emoji is typed #22827

Improved selection placement when emoji is typed #22827

Conversation

alitoshmatov commented Jul 13, 2023 • edited by MariaHCD Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 13, 2023

alitoshmatov commented Jul 13, 2023 • edited Loading

aimane-chnaif commented Jul 14, 2023 • edited Loading

aimane-chnaif commented Jul 14, 2023

alitoshmatov commented Jul 14, 2023

aimane-chnaif commented Jul 14, 2023

aimane-chnaif commented Jul 14, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

MariaHCD left a comment

Choose a reason for hiding this comment

aimane-chnaif left a comment

Choose a reason for hiding this comment

MariaHCD left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 19, 2023

eVoloshchak Oct 11, 2023

Choose a reason for hiding this comment

alitoshmatov commented Jul 13, 2023 •

edited by MariaHCD

Loading

alitoshmatov commented Jul 13, 2023 •

edited

Loading

aimane-chnaif commented Jul 14, 2023 •

edited

Loading